Add documentation on library backup & restore - #1335
Conversation
|
Thanks @sarina, this looks great to me. I reviewed the documentation and they instructions are clear and cover the details well. The one area of feedback I have is around naming-- because Content Libraries support a separate "Import" feature that is a course → library content import, I would recommend avoiding naming overlap for this documentation page and its sections. As of the last time we discussed this, I think we wanted to use "Backup to local archive" and "Create from archive" or "Restore from archive" to avoid the naming overlap. @jmakowski1123 may have additional thoughts (also CC @edschema) The naming overlap between different platform features (import / export / backup / restore / migrate) is confusing, and I think it would be worth standardizing at some point. For now, I think limiting the overlap will help reduce possible confusion (especially since the Library menu Tools → Import is for course to library content import, not restore-from-backup). |
sdaitzman
left a comment
sdaitzman
left a comment
There was a problem hiding this comment.
Looks great to me, requesting some very minor changes to phrasing to avoid overlap between create-from-archive and course import tools
|
|
||
| #. When the import process finishes, you'll be taken to your new library. | ||
|
|
||
| .. seealso:: |
There was a problem hiding this comment.
I wonder about also linking to migration and course import documentation here, since those are related concepts that enable users to move content back and forth between different areas of the platform
There was a problem hiding this comment.
Do you have links to the documentation you're mentioning?
There was a problem hiding this comment.
Looking into whether we have documentation for those areas; unfortunately I think they may be additional gaps
There was a problem hiding this comment.
Otherwise, could you possibly make some issues for the missing docs and approve this PR, and we can write up the missing docs & link them here as they're written
There was a problem hiding this comment.
I added this reference, it seems like #1348 isn't ready for documentation yet so we don't need to reference it yet, and we can move forward with merging this PR. Would you agree?
Agree we don't want duplicative naming for Import. We did land on "Backup to local archive" and "Restore from archive". |
sarina
changed the title
ba943c4 to
f6b39a4
Compare
|
@jmakowski1123 I had already adjusted the language to use Backup/Restore, please let me know if you think I missed something! |
3 participants
https://docsopenedxorg--1335.org.readthedocs.build/en/1335/educators/how-tos/course_development/import_export_library.html